home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / scram37.zip / SCRAMBLE.DOC < prev    next >
Text File  |  1992-12-08  |  16KB  |  396 lines
  1.  
  2.                       ┌────────────────────────────┐
  3.                       │============================│
  4.                       │      S C R A M B L E !     │
  5.                       │============================│
  6.                       │  (C)1990,92 T&J SOFTWARE   │
  7.                       └────────────────────────────┘
  8.         One of the T&J Software Collection of multi-BBS door programs.
  9.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  10.              UltraBBS, Telegard, TriBBS, Remote Access, WWIV, and
  11.                                 Digiboard
  12.  
  13.                        VERSION 3.7      12/04/92
  14.  
  15.                                    By
  16.  
  17.                                Tom Wildoner
  18.                              397 West Broadway
  19.                               Jim Thorpe, PA
  20.                                   18229
  21.                             VOICE (717)325-9480
  22.  
  23.                                    From
  24.  
  25.                                The T&J BBS
  26.                               (717)325-9481
  27.                              12/24/9600/14400
  28.  
  29. LEGALITIES:
  30. ===========
  31.  
  32.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  33.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  34.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  35.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  36.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  37.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  38.       OR BREACH OF ANY WARRANTY.
  39.  
  40. SUPPORT:
  41. ========
  42.  
  43. Please feel free to call me at my BBS number or voice number. Word
  44. lists will be available on my BBS for download as they are prepared.
  45.  
  46. DISTRIBUTION:
  47. =============
  48.  
  49. You may make this file available for downloading from your BBS or you may
  50. upload it to any BBS of your choice, provided that you do not make any
  51. changes to the contents of the archive (ZIP file). The archive and its
  52. individual contents may not be used by any service that charges any money
  53. whatsoever, without the written permission of the author.
  54.  
  55. REGISTERING:
  56. ============
  57.  
  58. Scramble will only pick words from word list number one until registered.
  59. Scramble will only use the first 25 words from word list one until
  60. registered.
  61.  
  62. Once registered -- it will unlock all the features of the registered
  63. version including the full 30,000+ word lists!
  64.  
  65. FEATURES:
  66. =========
  67.            --- Return to BBS on dropped carrier.
  68.            --- 4-minutes no activity will return to BBS.
  69.            --- Online Chat.
  70.            --- You can blank the display.
  71.            --- Dump user back to BBS.
  72.            --- Drop to DOS function.
  73.            --- Desqview Aware.
  74.            --- COM1-4 support and non-standard IRQ's.
  75.            --- Colorful ANSI screens.
  76.            --- Makes TOP TEN ANSI & ASCII bulletins.
  77.            --- NO BRUN module needed for play.
  78.            --- BETA tested on five different boards.
  79.            --- Use of HOT KEYS while in the door.
  80.            --- Support BBS available.
  81.            --- Easily RESET the entire program.
  82.            --- Self maintaining no maintenance required.
  83.            --- Door resets every month to give ALL players a chance.
  84.            --- Fossil driver support.
  85.  
  86.  
  87. INSTALLATION:     IMPORTANT!!!!!!!
  88. ==================================
  89.  
  90. Run Scramble using the command line UTILITY.
  91.  
  92. Example: SCRAM UTILITY
  93.  
  94. Then, reset the door from scratch. You can also easily setup your
  95. configuration files this way!
  96.  
  97. CONFIGURATION:
  98. =============
  99.  
  100. Example configuration file for PCBOARD.SYS
  101. ------------------------------------------
  102.  
  103. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  104. T&J Software        <=-  (Change this to your BBS name)
  105. Tom                 <=-  (The Sysop's first name)
  106. Wildoner            <=-  (The Sysop's last name)
  107.  
  108. Example configuration file for USERS.SYS
  109. ----------------------------------------
  110.  
  111. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  112. T&J Software        <=-  (Change this to your BBS name)
  113. Tom                 <=-  (The Sysop's first name)
  114. Wildoner            <=-  (The Sysop's last name)
  115.  
  116. Example configuration file for DOOR.SYS
  117. ---------------------------------------
  118.  
  119. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  120. T&J Software        <=-  (Change this to your BBS name)
  121. Tom                 <=-  (The Sysop's first name)
  122. Wildoner            <=-  (The Sysop's last name)
  123.  
  124. Example configuration file for USERINFO.DAT
  125. -------------------------------------------
  126.  
  127. C:\BBS\USERINFO.DAT <=-  (Full pathname of your USERINFO.DAT file)
  128. T&J Software        <=-  (Change this to your BBS name)
  129. Tom                 <=-  (The Sysop's first name)
  130. Wildoner            <=-  (The Sysop's last name)
  131. NOTE: DOOR.SYS must be in the SAME directory as USERINFO.DAT
  132.  
  133. Example configuration file for CALLINFO.BBS
  134. -------------------------------------------
  135.  
  136. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  137. T&J Software        <=-  (Change this to your BBS name)
  138. Tom                 <=-  (The Sysop's first name)
  139. Wildoner            <=-  (The Sysop's last name)
  140.  
  141. Example configuration file for DORINFOx.DEF
  142. -------------------------------------------
  143.  
  144. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  145.                           where 'x' is the BBS Node number.
  146. T&J Software        <=-  (Change this to your BBS name)
  147. Tom                 <=-  (The Sysop's first name)
  148. Wildoner            <=-  (The Sysop's last name)
  149.  
  150. Example configuration file for SFDOORS.DAT
  151. ------------------------------------------
  152.  
  153. C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  154. T&J Software        <=-  (Change this to your BBS name)
  155. Tom                 <=-  (The Sysop's first name)
  156. Wildoner            <=-  (The Sysop's last name)
  157.  
  158. Example configuration file for CHAIN.TXT
  159. ----------------------------------------
  160.  
  161. C:\BBS\CHAIN.TXT    <=-  (Full pathname of your CHAIN.TXT file)
  162. T&J Software        <=-  (Change this to your BBS name)
  163. Tom                 <=-  (The Sysop's first name)
  164. Wildoner            <=-  (The Sysop's last name)
  165.  
  166. Example configuration file for GTUSER.BBS
  167. -----------------------------------------
  168.  
  169. C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  170. T&J Software        <=-  (Change this to your BBS name)
  171. Tom                 <=-  (The Sysop's first name)
  172. Wildoner            <=-  (The Sysop's last name)
  173. 1                   <=-  (COM port number - defaults to 1)
  174. 1                   <=-  (Node number - defaults to 1)
  175.  
  176. Example Batch File
  177. ==================
  178.  
  179. A sample batch file is included and is similer to the following:
  180.    ECHO OFF
  181.    CD\DOORS\LEMON           <=- Switch to the door's Directory.
  182.    SCRAM SCRAM.CFG          <=- Execute the door program and pass the
  183.                                 configuration filename to the program.
  184.    CD\PCB                   <=- Go back to PCB DIR when user exits door.
  185.    BOARD                    <=- Restart BBS.
  186.  
  187. This Door is multi-node  compatible so you may run more than 1 node from
  188. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  189. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  190. variables, (q.v.)
  191.  
  192. Environment Variables
  193. =====================
  194.  
  195. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  196. variables. Non-PCBoard systems may also use these variables by including
  197. the following in either your BBS batch or AUTOEXEC.BAT
  198.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  199.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  200. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  201. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  202. .CFG file for multi-node operation!
  203.  
  204. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  205. command line.  For example:
  206.  
  207.      SCRAM SCRAM.CFG /5
  208. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  209.      SCRAM SCRAM.CFG /%IRQ%
  210.  
  211. This tells the program to use IRQ 5 instead of the standard IRQ.
  212.  
  213.   Had reports of conflicts when using non-standard IRQ's on Novell/Netware
  214.  systems. Seems Novell also uses the / character so something went screwy
  215.  somewhere. So I added the * (asterisk) which may be used instead of the /
  216.  in case of a conflict. In other words, /%IRQ% and *%IRQ% will both work
  217.  and are interchangeable.
  218.  
  219. When specifying the location of the system file on line 1 of the doors .CFG
  220. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%,
  221. and %wcnodeid%. Some examples:
  222.  PCBoard: 
  223.    USERS.SYS in C:\PCB           - %pcbdrive%%pcbdir%\USERS.SYS
  224.    USERS.SYS in C:\PCB\NODE1     - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS
  225.  
  226.  Wildcat!:
  227.    USERINFO.DAT in C:\WC\NODE1   - C:\WC\NODE%wcnodeid%
  228.  
  229. Non-PCBoard systems may use the PCB environment variables by setting them
  230. in either AUTOEXEC.BAT or in the batch that runs the door. For example:
  231.  SET PCBDRIVE=C:
  232.  SET PCBDIR=\BBSDIR
  233.  SET PCBNODE=1
  234.  
  235. Fossil Driver Support
  236. ---------------------
  237. DoorFrame supports the use of Fossil drivers.  To tell your Door to use the
  238. Fossil driver instead of the standard COM ports, just put /FD on the command
  239. line when running the door. For example:
  240.      MYDOOR MYDOOR.CFG /FD
  241. indicates that a Fossil driver is present and should be used. If no Fossil
  242. driver is detected, DoorFrame will print a message to that effect and exit
  243. the door gracefully.
  244.  
  245.  
  246. Sysop Keys
  247. ==========
  248.  
  249. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  250.          written to DOOR.SYS and USERS.SYS
  251. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  252.          and/or written to DOOR.SYS and USERS.SYS
  253. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  254. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  255.          and/or written to DOOR.SYS and USERS.SYS
  256. F8    -  Returns the caller involuntarily to the BBS.
  257. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  258.          and/or written to DOOR.SYS and USERS.SYS
  259. F10   -  Activates SysOp CHAT mode within the DOOR.
  260. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  261. UP    -  Give the caller extra time while in the DOOR.  
  262. DN    -  Subtract time from the caller while in the DOOR. 
  263. HOME  -  HELP key for Status Line options.
  264. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  265. ALT-X -  PCBoard will exit after current caller logs off. Value is
  266.          passed to PCBoard. Not available on non-PCBoard systems.
  267.  
  268.  
  269. YOUR CONFIGURATION FILE:
  270. ========================
  271.  
  272. Change the SYSOP.CFG file to meet your needs:
  273.  
  274. 25
  275. 61
  276. 500
  277. 12
  278. Y
  279. C:\WC30\BULL\BULL99.SCR
  280. C:\WC30\BULL\BULL99.BBS
  281.  
  282. LINE 1: Number of words/play a user may attempt.
  283. LINE 2: Number of WORDx.TXT files you have.
  284. LINE 3: Number of words per WORDx.TXT file.
  285. LINE 4: Current month. Used for resetting the scores monthly!
  286. LINE 5: Tournament mode (Y or N)
  287. LINE 6: Path to your color bulletin.
  288. LINE 7: Path to your ASCII bulletin.
  289.  
  290. The only items you need to set initially are lines 5, 6, and 7. The
  291. first four lines will all be configured for you. You can alter line one
  292. if you feel 25 words per play is too low or high.
  293.  
  294. TOURNAMENT MODE:
  295. ================
  296.  
  297. Turning tournament mode on does the following: The first player of the
  298. day will have to wait a few seconds until the tournament words are
  299. selected. Next, the tournament words will be compiled into a file
  300. called TOURNY.TXT. All users who play today will get the same words
  301. (scrambled differently). The tournament generator will look at your
  302. SYSOP.CFG file, look at line one (for the number of words), and will
  303. pick that number of words randomly from all your WORDx.TXT files.
  304.  
  305. The above file will come configured to the word lists which are shipped
  306. with the game. As you add word lists, simply change lines 2 and 3 to
  307. reflect the changes! Scramble currently ships with 30,000+ words!
  308.  
  309. LOCAL MODE:
  310. ===========
  311.  
  312. To run in LOCAL mode simply run SCRAMBLE using the LOCAL command line:
  313.  
  314. Example: SCRAM LOCAL
  315.  
  316. RESETTING:
  317. ==========
  318.  
  319. Scramble will reset at the first of each month -- no maintenance
  320. needed. However, you can reset Scramble any time you wish using the
  321. UTILITY command string and then selecting the appropriate menu
  322. item.
  323.  
  324. WORD LISTS:
  325. ===========
  326.  
  327. Scramble currently ships with 61 word lists -- each list contains 500
  328. words! You can have up to 100 word lists (WORD1.TXT to WORD100.TXT), but
  329. each list must have the same number of words. Let's say you make your own
  330. word list containing 500 words. This will be your 62nd word list. Name
  331. your word list WORD62.TXT and place it in your SCRAMBLE directory. Next,
  332. change line 2 of your SYSOP.CFG file to 62 -- that's it, Scramble will
  333. now accept words from your word list!
  334.  
  335. If you start making word lists, please UL them to my BBS so I can
  336. incorporate them into future versions and make them available to other
  337. Scramble users to DL.
  338.  
  339. FUTURE VERSIONS:
  340. ================
  341.  
  342.    ---> What would you like to see added? Just let me know.
  343.  
  344. VERSION HISTORY:
  345. ================
  346.  
  347. Version 1.00 ......... First release. 2/2/91
  348. Version 1.10 ......... Maintenance update. Changed BBS name. 8/17/91
  349. Version 2.00 ......... Now using BASIC PDS v7.1, all external files
  350.                        placed inside the main code, now support WC!
  351.                        2.x and 3.x, added tournament mode. 10/1/91
  352. Version 2.10 ......... Fix for BBS running with com port unlocked.
  353.                        Other small mods made also.  02/01/92
  354. Version 3.00 ......... Converted to DoorFrame routines -- facelift
  355.                        for the program. 02/23/92
  356. Version 3.10 ......... Recompiled using newer DoorFrame routines and
  357.                        added new bulletin routines.  04-17-1992
  358. Version 3.50 ......... Cleaned the code a little, added the ability
  359.                        to view the TOP TEN while in the door, got
  360.                        rid of the SEXTRA program, made a new RESET
  361.                        program, moved tournament routines inside the
  362.                        main code. 05-16-92
  363. Version 3.60 ......... Verify and Setup have been moved into the main
  364.                        code. Door updated with the newest door routines.
  365.                        05-24-92
  366. Version 3.60 ......... Fixed small problem with Scramble not resetting
  367.                        the scores monthly. 06-06-92
  368. Version 3.70 ......... Basically re-wrote the entire door. Got rid of
  369.                        some menacing screens. Added 'V' at the main
  370.                        menu to view the scores. Added almost 30,000
  371.                        words to the door. Now supports fossil drivers
  372.                        and IRQ number larger than one
  373.                        digit. Got rid of the BONUS CATAGORY listing
  374.                        and decided to give bonus points just on word
  375.                        length. Added a new timer function that will
  376.                        give 20 seconds plus however many letters there
  377.                        are in the word. Added better support for
  378.                        boards running in a network environment and
  379.                        also now supports the short version of
  380.                        DOOR.SYS. The screen now automatically redraws
  381.                        after a CHAT or DROP to DOS. Got rid of the
  382.                        VERIFY program to verify word lists. The door
  383.                        will now run "registered" when playing locally
  384.                        and allow multiple people to play locally
  385.                        instead of just the sysop. 12-04-1992
  386.  
  387. That's all there is to it! If you have any problems or questions
  388. please feel free to call the T&J BBS at (717)325-9481.
  389.  
  390. Future add on word lists will be available to DL from my BBS.
  391.  
  392. See the REGISTER.TXT file for registering.
  393.  
  394. Your users will get a lot of duplicate words until the game is
  395. registered.
  396.